<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>GtkToggleAction</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.74.0">
<link rel="home" href="index.html" title="GTK+ Reference Manual">
<link rel="up" href="Actions.html" title="Action-based menus and toolbars">
<link rel="prev" href="GtkAction.html" title="GtkAction">
<link rel="next" href="GtkRadioAction.html" title="GtkRadioAction">
<meta name="generator" content="GTK-Doc V1.11 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
<link rel="part" href="gtk.html" title="Part I. GTK+ Overview">
<link rel="part" href="gtkbase.html" title="Part II. GTK+ Core Reference">
<link rel="part" href="gtkobjects.html" title="Part III. GTK+ Widgets and Objects">
<link rel="chapter" href="ch01.html" title="Object Hierarchy">
<link rel="chapter" href="ch02.html" title="Widget Gallery">
<link rel="chapter" href="WindowWidgets.html" title="Windows">
<link rel="chapter" href="DisplayWidgets.html" title="Display Widgets">
<link rel="chapter" href="ButtonWidgets.html" title="Buttons and Toggles">
<link rel="chapter" href="NumericEntry.html" title="Numeric/Text Data Entry">
<link rel="chapter" href="TextWidgetObjects.html" title="Multiline Text Editor">
<link rel="chapter" href="TreeWidgetObjects.html" title="Tree, List and Icon Grid Widgets">
<link rel="chapter" href="MenusAndCombos.html" title="Menus, Combo Box, Toolbar">
<link rel="chapter" href="Actions.html" title="Action-based menus and toolbars">
<link rel="chapter" href="SelectorWidgets.html" title="Selectors (File/Font/Color/Input Devices)">
<link rel="chapter" href="LayoutContainers.html" title="Layout Containers">
<link rel="chapter" href="Ornaments.html" title="Ornaments">
<link rel="chapter" href="ScrollingWidgets.html" title="Scrolling">
<link rel="chapter" href="Printing.html" title="Printing">
<link rel="chapter" href="MiscObjects.html" title="Miscellaneous">
<link rel="chapter" href="AbstractObjects.html" title="Abstract Base Classes">
<link rel="chapter" href="PlugSocket.html" title="Cross-process Embedding">
<link rel="chapter" href="SpecialObjects.html" title="Special-purpose features">
<link rel="chapter" href="RecentDocuments.html" title="Recently Used Documents">
<link rel="chapter" href="Builder.html" title="Interface builder">
<link rel="chapter" href="DeprecatedObjects.html" title="Deprecated">
<link rel="part" href="migrating.html" title="Part IV. Migrating from Previous Versions of GTK+">
<link rel="chapter" href="gtk-migrating-checklist.html" title="Migration Checklist">
<link rel="chapter" href="gtk-migrating-GtkFileChooser.html" title="Migrating from GtkFileSelection to GtkFileChooser">
<link rel="chapter" href="gtk-migrating-GtkAction.html" title="Migrating from old menu and toolbar systems to GtkAction">
<link rel="chapter" href="gtk-migrating-GtkComboBox.html" title="Migrating from GtkOptionMenu and GtkCombo to GtkComboBox and GtkComboBoxEntry">
<link rel="chapter" href="gtk-migrating-GtkIconView.html" title="Migrating from GnomeIconList to GtkIconView">
<link rel="chapter" href="gtk-migrating-GtkAboutDialog.html" title="Migrating from GnomeAbout to GtkAboutDialog">
<link rel="chapter" href="gtk-migrating-GtkColorButton.html" title="Migrating from GnomeColorPicker to GtkColorButton">
<link rel="chapter" href="gtk-migrating-GtkAssistant.html" title="Migrating from GnomeDruid to GtkAssistant">
<link rel="chapter" href="gtk-migrating-GtkRecentChooser.html" title="Migrating from EggRecent to GtkRecentChooser">
<link rel="chapter" href="gtk-migrating-GtkLinkButton.html" title="Migrating from GnomeHRef to GtkLinkButton">
<link rel="chapter" href="gtk-migrating-GtkBuilder.html" title="Migrating from libglade to GtkBuilder">
<link rel="chapter" href="gtk-migrating-tooltips.html" title="Migrating from GtkTooltips to GtkTooltip">
<link rel="part" href="pt05.html" title="Part V. GTK+ Tools">
<link rel="glossary" href="glossary.html" title="Glossary">
<link rel="index" href="api-index-full.html" title="Index of all symbols">
<link rel="index" href="api-index-deprecated.html" title="Index of deprecated symbols">
<link rel="index" href="api-index-2-2.html" title="Index of new symbols in 2.2">
<link rel="index" href="api-index-2-4.html" title="Index of new symbols in 2.4">
<link rel="index" href="api-index-2-6.html" title="Index of new symbols in 2.6">
<link rel="index" href="api-index-2-8.html" title="Index of new symbols in 2.8">
<link rel="index" href="api-index-2-10.html" title="Index of new symbols in 2.10">
<link rel="index" href="api-index-2-12.html" title="Index of new symbols in 2.12">
<link rel="index" href="api-index-2-14.html" title="Index of new symbols in 2.14">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
<tr valign="middle">
<td><a accesskey="p" href="GtkAction.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="Actions.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
<th width="100%" align="center">GTK+ Reference Manual</th>
<td><a accesskey="n" href="GtkRadioAction.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#GtkToggleAction.synopsis" class="shortcut">Top</a>
                 | 
                <a href="#GtkToggleAction.description" class="shortcut">Description</a>
                 | 
                <a href="#GtkToggleAction.object-hierarchy" class="shortcut">Object Hierarchy</a>
                 | 
                <a href="#GtkToggleAction.implemented-interfaces" class="shortcut">Implemented Interfaces</a>
                 | 
                <a href="#GtkToggleAction.properties" class="shortcut">Properties</a>
                 | 
                <a href="#GtkToggleAction.signals" class="shortcut">Signals</a>
</td></tr>
</table>
<div class="refentry" lang="en">
<a name="GtkToggleAction"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="GtkToggleAction.top_of_page"></a>GtkToggleAction</span></h2>
<p>GtkToggleAction — An action which can be toggled between two states</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<a name="GtkToggleAction.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis">

#include &lt;gtk/gtk.h&gt;

                    <a class="link" href="GtkToggleAction.html#GtkToggleAction-struct" title="GtkToggleAction">GtkToggleAction</a>;
<a class="link" href="GtkToggleAction.html" title="GtkToggleAction">GtkToggleAction</a> *   <a class="link" href="GtkToggleAction.html#gtk-toggle-action-new" title="gtk_toggle_action_new ()">gtk_toggle_action_new</a>               (const <a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
>gchar</a> *name,
                                                         const <a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
>gchar</a> *label,
                                                         const <a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
>gchar</a> *tooltip,
                                                         const <a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
>gchar</a> *stock_id);
void                <a class="link" href="GtkToggleAction.html#gtk-toggle-action-toggled" title="gtk_toggle_action_toggled ()">gtk_toggle_action_toggled</a>           (<a class="link" href="GtkToggleAction.html" title="GtkToggleAction">GtkToggleAction</a> *action);
void                <a class="link" href="GtkToggleAction.html#gtk-toggle-action-set-active" title="gtk_toggle_action_set_active ()">gtk_toggle_action_set_active</a>        (<a class="link" href="GtkToggleAction.html" title="GtkToggleAction">GtkToggleAction</a> *action,
                                                         <a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"
>gboolean</a> is_active);
<a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"
>gboolean</a>            <a class="link" href="GtkToggleAction.html#gtk-toggle-action-get-active" title="gtk_toggle_action_get_active ()">gtk_toggle_action_get_active</a>        (<a class="link" href="GtkToggleAction.html" title="GtkToggleAction">GtkToggleAction</a> *action);
void                <a class="link" href="GtkToggleAction.html#gtk-toggle-action-set-draw-as-radio" title="gtk_toggle_action_set_draw_as_radio ()">gtk_toggle_action_set_draw_as_radio</a> (<a class="link" href="GtkToggleAction.html" title="GtkToggleAction">GtkToggleAction</a> *action,
                                                         <a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"
>gboolean</a> draw_as_radio);
<a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"
>gboolean</a>            <a class="link" href="GtkToggleAction.html#gtk-toggle-action-get-draw-as-radio" title="gtk_toggle_action_get_draw_as_radio ()">gtk_toggle_action_get_draw_as_radio</a> (<a class="link" href="GtkToggleAction.html" title="GtkToggleAction">GtkToggleAction</a> *action);
</pre>
</div>
<div class="refsect1" lang="en">
<a name="GtkToggleAction.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="synopsis">
  <a
href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GObject"
>GObject</a>
   +----<a class="link" href="GtkAction.html" title="GtkAction">GtkAction</a>
         +----GtkToggleAction
               +----<a class="link" href="GtkRadioAction.html" title="GtkRadioAction">GtkRadioAction</a>
</pre>
</div>
<div class="refsect1" lang="en">
<a name="GtkToggleAction.implemented-interfaces"></a><h2>Implemented Interfaces</h2>
<p>
GtkToggleAction implements
 <a class="link" href="gtk-gtkbuildable.html#GtkBuildable">GtkBuildable</a>.</p>
</div>
<div class="refsect1" lang="en">
<a name="GtkToggleAction.properties"></a><h2>Properties</h2>
<pre class="synopsis">
  "<a class="link" href="GtkToggleAction.html#GtkToggleAction--active" title='The "active" property'>active</a>"                   <a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"
>gboolean</a>              : Read / Write
  "<a class="link" href="GtkToggleAction.html#GtkToggleAction--draw-as-radio" title='The "draw-as-radio" property'>draw-as-radio</a>"            <a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"
>gboolean</a>              : Read / Write
</pre>
</div>
<div class="refsect1" lang="en">
<a name="GtkToggleAction.signals"></a><h2>Signals</h2>
<pre class="synopsis">
  "<a class="link" href="GtkToggleAction.html#GtkToggleAction-toggled" title='The "toggled" signal'>toggled</a>"                                        : Run First
</pre>
</div>
<div class="refsect1" lang="en">
<a name="GtkToggleAction.description"></a><h2>Description</h2>
<p>
A <a class="link" href="GtkToggleAction.html" title="GtkToggleAction"><span class="type">GtkToggleAction</span></a> corresponds roughly to a <a class="link" href="GtkCheckMenuItem.html" title="GtkCheckMenuItem"><span class="type">GtkCheckMenuItem</span></a>. It has an
"active" state specifying whether the action has been checked or not.
</p>
</div>
<div class="refsect1" lang="en">
<a name="GtkToggleAction.details"></a><h2>Details</h2>
<div class="refsect2" lang="en">
<a name="GtkToggleAction-struct"></a><h3>GtkToggleAction</h3>
<pre class="programlisting">typedef struct _GtkToggleAction GtkToggleAction;</pre>
<p>
The <span class="structname">GtkToggleAction</span> struct contains only
private members and should not be accessed directly.
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="gtk-toggle-action-new"></a><h3>gtk_toggle_action_new ()</h3>
<pre class="programlisting"><a class="link" href="GtkToggleAction.html" title="GtkToggleAction">GtkToggleAction</a> *   gtk_toggle_action_new               (const <a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
>gchar</a> *name,
                                                         const <a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
>gchar</a> *label,
                                                         const <a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
>gchar</a> *tooltip,
                                                         const <a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
>gchar</a> *stock_id);</pre>
<p>
Creates a new <a class="link" href="GtkToggleAction.html" title="GtkToggleAction"><span class="type">GtkToggleAction</span></a> object. To add the action to
a <a class="link" href="GtkActionGroup.html" title="GtkActionGroup"><span class="type">GtkActionGroup</span></a> and set the accelerator for the action,
call <a class="link" href="GtkActionGroup.html#gtk-action-group-add-action-with-accel" title="gtk_action_group_add_action_with_accel ()"><code class="function">gtk_action_group_add_action_with_accel()</code></a>.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>name</code></em> :</span></p></td>
<td> A unique name for the action
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>label</code></em> :</span></p></td>
<td> The label displayed in menu items and on buttons, or <a
href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL--CAPS"
><code class="literal">NULL</code></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>tooltip</code></em> :</span></p></td>
<td> A tooltip for the action, or <a
href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL--CAPS"
><code class="literal">NULL</code></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>stock_id</code></em> :</span></p></td>
<td> The stock icon to display in widgets representing the
  action, or <a
href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL--CAPS"
><code class="literal">NULL</code></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> a new <a class="link" href="GtkToggleAction.html" title="GtkToggleAction"><span class="type">GtkToggleAction</span></a>

</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 2.4</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="gtk-toggle-action-toggled"></a><h3>gtk_toggle_action_toggled ()</h3>
<pre class="programlisting">void                gtk_toggle_action_toggled           (<a class="link" href="GtkToggleAction.html" title="GtkToggleAction">GtkToggleAction</a> *action);</pre>
<p>
Emits the "toggled" signal on the toggle action.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><em class="parameter"><code>action</code></em> :</span></p></td>
<td> the action object
</td>
</tr></tbody>
</table></div>
<p class="since">Since 2.4</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="gtk-toggle-action-set-active"></a><h3>gtk_toggle_action_set_active ()</h3>
<pre class="programlisting">void                gtk_toggle_action_set_active        (<a class="link" href="GtkToggleAction.html" title="GtkToggleAction">GtkToggleAction</a> *action,
                                                         <a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"
>gboolean</a> is_active);</pre>
<p>
Sets the checked state on the toggle action.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>action</code></em> :</span></p></td>
<td> the action object
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>is_active</code></em> :</span></p></td>
<td> whether the action should be checked or not
</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 2.4</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="gtk-toggle-action-get-active"></a><h3>gtk_toggle_action_get_active ()</h3>
<pre class="programlisting"><a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"
>gboolean</a>            gtk_toggle_action_get_active        (<a class="link" href="GtkToggleAction.html" title="GtkToggleAction">GtkToggleAction</a> *action);</pre>
<p>
Returns the checked state of the toggle action.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>action</code></em> :</span></p></td>
<td> the action object
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> the checked state of the toggle action

</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 2.4</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="gtk-toggle-action-set-draw-as-radio"></a><h3>gtk_toggle_action_set_draw_as_radio ()</h3>
<pre class="programlisting">void                gtk_toggle_action_set_draw_as_radio (<a class="link" href="GtkToggleAction.html" title="GtkToggleAction">GtkToggleAction</a> *action,
                                                         <a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"
>gboolean</a> draw_as_radio);</pre>
<p>
Sets whether the action should have proxies like a radio action.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>action</code></em> :</span></p></td>
<td> the action object
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>draw_as_radio</code></em> :</span></p></td>
<td> whether the action should have proxies like a radio 
   action
</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 2.4</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="gtk-toggle-action-get-draw-as-radio"></a><h3>gtk_toggle_action_get_draw_as_radio ()</h3>
<pre class="programlisting"><a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"
>gboolean</a>            gtk_toggle_action_get_draw_as_radio (<a class="link" href="GtkToggleAction.html" title="GtkToggleAction">GtkToggleAction</a> *action);</pre>
<p>
Returns whether the action should have proxies like a radio action.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>action</code></em> :</span></p></td>
<td> the action object
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> whether the action should have proxies like a radio action.

</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 2.4</p>
</div>
</div>
<div class="refsect1" lang="en">
<a name="GtkToggleAction.property-details"></a><h2>Property Details</h2>
<div class="refsect2" lang="en">
<a name="GtkToggleAction--active"></a><h3>The <code class="literal">"active"</code> property</h3>
<pre class="programlisting">  "active"                   <a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"
>gboolean</a>              : Read / Write</pre>
<p>
If the toggle action should be active in or not.</p>
<p>
</p>
<p>Default value: FALSE</p>
<p>Since 2.10</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="GtkToggleAction--draw-as-radio"></a><h3>The <code class="literal">"draw-as-radio"</code> property</h3>
<pre class="programlisting">  "draw-as-radio"            <a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"
>gboolean</a>              : Read / Write</pre>
<p>Whether the proxies for this action look like radio action proxies.</p>
<p>Default value: FALSE</p>
</div>
</div>
<div class="refsect1" lang="en">
<a name="GtkToggleAction.signal-details"></a><h2>Signal Details</h2>
<div class="refsect2" lang="en">
<a name="GtkToggleAction-toggled"></a><h3>The <code class="literal">"toggled"</code> signal</h3>
<pre class="programlisting">void                user_function                      (<a class="link" href="GtkToggleAction.html" title="GtkToggleAction">GtkToggleAction</a> *toggleaction,
                                                        <a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"
>gpointer</a>         user_data)         : Run First</pre>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>toggleaction</code></em> :</span></p></td>
<td>the object which received the signal.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
<td>user data set when the signal handler was connected.</td>
</tr>
</tbody>
</table></div>
</div>
</div>
</div>
<div class="footer">
<hr>
          Generated by GTK-Doc V1.11</div>
</body>
</html>
